Model Attribute Description

The HL7 attribute classCode describes the type of role using a value from the RoleClassAssociative domain of the HL7 vocabulary RoleClass.

Implementation in XML Instance

The XML attribute classCode shall carry a code from the RoleClassAssociative domain of the HL7 vocabulary RoleClass. The recommended codes to use are listed in the table below:

Code	Display name	Definition
ASSIGNED	assigned entity	An assigned entity is a type of agent in which, the player is a person acting in the employ a scoping organisation.
CAREGIVER	caregiver	A person responsible for the primary care of a patient at home.
CRINV	clinical research investigator	A clinical research investigator is a type of formal relationship in which, the player is a person that has authority from a clinical research sponsor (scoper) to direct the conduct of a clinical research trial or study on behalf of that sponsor.
COMPAR	commissioning party	A commissioning party is a type of assigned entity in which, the player is an entity that is authorised to issue or instantiate permissions, privileges, credentials or other formal/legal agreements on behalf of a scoping entity.
EMP	employee	An employee is a type of formal relationship in which, the player is a person or organisation is contracted by a scoping organisation or person to undertake work for compensation. The employee role represents the nature of the employment relationship. In contrast assigned entity represents the function role (i.e. the nature of the work undertaken).
IDENT	identified entity	An identified entity is a type of passive role in which, the player is an entity that is assigned an identifier by a scoping entity.
LIC	licensed entity	A licensed entity is a type of formal relationship in which, the scoper certifies the player to perform certain activities that fall under the jurisdiction of the scoper. For example, The GMC licenses doctors to practice medicine in the UK.
MIL	military person	A military person is a type of employee in which, the player is a person who is a member of a military service. The scoping entity is the military service organisation or unit.
PROV	healthcare provider	A healthcare provider is a type of licensed entity in which, the player is an entity that is authorised to provide healthcare serviced by scoping authority.
QUAL	qualified entity	A qualified entity is a type of formal relationship in which, the player is an entity that is recognised as having training, experience, etc that makes them an appropriate performer of certain types of activity. The qualification is issued by the scoping entity. For example, a doctor is a qualified entity scoped by a medical school.
SGNOFF	signing authority or officer	A signing authority or officer is a type of assigned entity in which, the player is a person that who is the officer or signature authority for a scoping entity.
STD	student	A student is a type of formal relationship in which, the player is a person who is a student of a school or other educational establishment (scoper).

Model Attribute Description

The HL7 attribute addr uses an address for person playing the role.

The HL7 attribute addr allows structured and unstructured addresses to be carried. Only structured addresses are recommended to be used.

Implementation in XML Instance

There are a number of forms of structured address. The three shown here are the recommended formats for the address, they are listed in no particular order.

The XML element addr is populated as follows:

When using the structured address in the style of PDS the XML element addr shall contain five XML elements streetAddressLine.

• The first XML element streetAddressLine shall contain the premises name
  
• The second XML element streetAddressLine shall contain the number and thoroughfare
• The third XML element streetAddressLine shall contain the locality
• The fourth XML element streetAddressLine shall contain the post town
• The fifth XML element streetAddressLine shall contain the county

The first XML element streetAddressLine or the second XML element streetAddressLine and the fourth XML element streetAddressLine are mandatory to be populated.

• The XML element postalCode can be used to carry a postcode
  
• The XML element addressKey can be used to carry a PAF key
  

When using the fully structured address format then the XML element addr shall be populated as follows:

• The XML element houseNumber shall contain the house/building number or name
  
• The XML element streetName shall contain the street name
  
• The XML element city shall contain the city name
  
• The XML element county shall contain the county
• The XML element country shall contain the country name
  
• The XML element postalCode shall contain the postcode
• The XML element addressKey shall contain the address key

Note that unpopulated XML elements should not be present.

Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.

• The first XML element streetAddressLine shall contain the first address line
  
• The second XML element streetAddressLine shall contain the second address line
• The third XML element streetAddressLine shall contain the third address line
• and so on ....

Note that unpopulated XML elements should not be present.

The XML element addr also allows an XML attribute use and this should be used to further define the person's address type when required. Only the use values listed below are recommended to be used for person's address.

Code	Definition
WP	Work place - An office address. First choice for business related contacts during business hours.
TMP	Temporary address - A temporary address; may be good for visit or mailing.
PHYS	Physical visit address - Used primarily to visit an address.
PST	Postal address - Used to send mail.
H	Home address - The person's home address; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
HP	The primary home address - An address to reach a person after business hours.
HV	A vacation home - An address to reach a person while on vacation.

When the XML attribute use of the XML element addr contains the value "PHYS" then the following two XML elements of the XML element addr may be populated.

• The XML element desc of the XML element addr may contain a description of the address; this may be used for things like directions for the address
• The XML element additionalLocator of the XML element addr may contain additional location information such as longitude and latitude coordinates
  

The XML element useablePeriod of XML element addr can be used to indicate some of the following types of valid times for an address:

• A point in time when the contact address details are valid
  
• A start and end time
• Just including hours and minutes to indicate opening hours of an office for a work address
  
• Using dates for indicating a contact address is only for a certain period of time
  
• A start time only to indicate when the contact address is valid from
• An end time only to indicate that the contact address is only valid until a certain date

Model Attribute Description

The HL7 attribute code uses a code from the HL7 vocabulary RoleCode or an alternative vocabulary to further describe the role code carried in the HL7 attribute classCode.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

When the RoleCode vocabulary is used then:

• The XML attribute code shall contain the code from the RoleCode vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.5.111"
• The XML attribute displayName shall carry the description associated with the code in the RoleCode vocabulary

The recommended codes to use with each classCode are listed below: Where there is no entry for a given classCode then it is recommended that the XML element code is not used.

Classcode	Code	DisplayName	Definition
STD	FSTUD	full-time student	Someone in full-time attendance at a recognized educational institution
	PSTUD	part-time student	Someone in part-time attendance at a recognized educational institution

When an alternative vocabulary is used and an OID is available then:

• The XML attribute code shall contain the code from the alternative vocabulary
• The XML attribute codeSystem shall contain the OID for the alternative vocabulary
• The XML attribute displayName shall carry the description alternative vocabulary.

When an alternative vocabulary is used and an OID is not available then:

• The XML attribute code shall contain the code from the alternative vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.409"
  
• The XML attribute displayName shall carry the description alternative vocabulary.

Model Attribute Description

The HL7 attribute id allows identification of the role using a national or local identifier.

Implementation in XML Instance

When the role is identified using SDS then the XML element id is populated as below:

The first instance of the XML element id is mandatory and shall carry the SDS User ID, the second instance of XML element id is required and shall carry the SDS User Role Profile ID when available on the sending system. The identifiers shall be carried in the XML element id as follows:

The first instance of the XML element id shall carry an SDS identifier that uniquely identifies the person as follows:

• The XML attribute root shall contain the OID "1.2.826.0.1285.0.2.0.65"
• The XML attribute extension shall contain the SDS User ID
  

The second instance of the XML element id shall carry the SDS identifier that uniquely identifies the role profile of the person as follows:

• The XML attribute root shall contain an OID with the value "1.2.826.0.1285.0.2.0.67"
• The XML attribute extension shall contain the SDS Role Profile ID

When the SDS role profile ID is not available then the XML element nullFlavor of the second XML element id must carry a value of "UNK".

When using alternative identifiers where the code system can be identified using an OID then the XML element id shall carry the identifiers as follows:

• The XML attribute root shall contain the OID for the identifying system.
• The XML attribute extension shall contain the identifier.

When using alternative identifiers where the code system can not be identified using an OID then the XML element id shall carry the identifiers as follows:

• The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.24".
• The XML attribute extension shall contain the identifier.
• The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:

assigningAuthorityName="RA9:SOUTH DEVON HEALTHCARE NHS TRUST"

Model Attribute Description

The HL7 attribute telecom specifies contact details for the person in the form of telephone numbers, fax numbers and email addresses.

Implementation in XML Instance

The XML value attribute of the XML element telecom should contain the telephone / fax number or an email address prefixed by the type of contact and a colon.

• For a telephone number the actual telephone number would be prefixed with tel:
• For a fax number the actual fax number would be prefixed with fax:
• For an email address the actual email address would be prefixed with mailto:
  

The XML attribute use of the XML element telecom may be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended to be used for the patient contact details:

Code	Definition
AS	Answering service - an automated answering machine used for less urgent cases and if the main purpose of contact is to leave a message or access an automated announcement.
EC	Emergency contact - A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.
H	Home - A communication address at a home, attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
HP	Home primary - the primary contact to reach a person after business hours.
HV	Home vacation - A vacation home, to reach a person while on vacation.
WP	Work place - An office address. First choice for business related contacts during business hours
PG	Pager - A paging device suitable to solicit a callback or to leave a very short message.
MC	Mobile contact - A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business.

The XML element useablePeriod of the XML element telecom may be used to indicate when the contact details given are valid, for example to indicate that a telephone number is only for office hours (9am to 5 pm). It can be used to indicate some of the following types of valid times:

• A point in time when the contact details are valid
  
• A start and end time
• Just including hours and minutes to indicate opening hours of an office for work contacts
  
• Using dates for indicating a contact is only for a certain period of time
  
• A start time only to indicate when the contact details are valid from
• An end time only to indicate that the contact details are only valid until a certain date

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145214GB01#AssociatedEntity".

A link to the person.

A link to the scoping organisation.

Model Attribute Description

The HL7 attribute classCode describes this class as a person.

Implementation in XML Instance

• The XML attribute classCode is fixed to "PSN".

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a person.

Implementation in XML Instance

• The XML attribute determinerCode is fixed to "INSTANCE".

Model Attribute Description

The HL7 attribute name provides a name associated with the person.

Implementation in XML Instance

The Person Name Structured with optional Use and optional Valid Time flavour of the PN data type is the recommended format for the person's name. This information is carried in the XML element name as follows:

• The XML element prefix should contain the person's title
• The XML element given should contain the person's forenames; there can be as many occurrences of the XML element as required
  
• The XML element family should contain the person's surname
• The XML element suffix may contain any suffix for the person
  

Additionally the XML attribute use of the XML element name should be used to indicate the type of name; the recommended codes to be used are listed below:

Note some of the codes listed are NHS extensions, these are marked with an *

Code	Definition
L	Legal
PREFERRED *	Preferred name

Additionally the XML element validTime of the XML element name may be used to indicate the time when the name is valid/was valid for the person, some uses are shown below:

• A point in time when the name details are known to be valid
  
• A start and end time
• To represent the period of time the person is/was known by this name
  
• A start time only to indicate when the name is/was valid from for the person
  
• An end time only to indicate that the name is/was only valid for the person until a certain date

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145214GB01#associatedPerson"

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

• The XML attribute classCode is fixed to "ORG".
  

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

• The XML attribute determinerCode is fixed to "INSTANCE".

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which employs the person in the role. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
• The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

• The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
• The XML attribute extension shall contain the ODS organisation code.

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

• The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.

Model Attribute Description

The HL7 attribute standardIndustryClassCode uses a code from any vocabulary to describe the type of organisation. The vocabulary OrganizationIndustryClass is the default HL7 vocabulary and is not recommended for use in the NHS and therefore a suitable local vocabulary should be used instead.

Implementation in XML Instance

The Coded with Equivalents (CE) data type shall be used to carry this information in the XML element standardIndustryClassCode as follows:

When an OID is available for the alternative vocabulary then:

• The XML attribute code shall contain a code from the alternative vocabulary
• The XML attribute codeSystem shall contain the OID for the alternative vocabulary
• The XML attribute displayName shall carry a description associated with the code in the alternative vocabulary
• The XML element originalText may be used if required to carry the text or phrase used as the basis for the coding

When no OID is available for the alternative vocabulary then:

• The XML attribute code shall contain a code from the alternative vocabulary
• The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.331"
• The XML attribute displayName shall carry a description associated with the code in the alternative vocabulary
• The XML element originalText may be used if required to carry the text or phrase used as the basis for the coding

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

• The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
• The XML attribute extension is fixed to "COCD_TP145214GB01#scopingOrganization".